.TH AMULECMD 1 "September 2009" "aMuleCmd v2.2.6" "aMule utilities"
.SH NAME
amulecmd \- Console-based program to control aMule
.SH SYNOPSIS
.B amulecmd
.RB [ \-h " " \fI<host> ]
.RB [ \-p " " \fI<port> ]
.RB [ \-P " " \fI<passwd> ]
.RB [ \-f " " \fI<path> ]
.RB [ \-q ]
.RB [ \-v ]
.RB [ \-l " " \fI<lang> ]
.RB [ \-w ]
.RB [ \-c " " \fI<command> ]
.PP
.B amulecmd
.B \-\-create-config-from=\fI<path>
.PP
.B amulecmd
.RB [ \-\-help ]
.PP
.B amulecmd
.RB [ \-\-version ]
.SH DESCRIPTION
\fBamulecmd\fR is a console-based client to control aMule.
.TP
\fB\-h\fR, \fB\-\-host\fR=\fI<host>\fR
Host where aMule is running (default: \fIlocalhost\fR).
\fI<host>\fR might be an IP address or a DNS name
.TP
\fB\-p\fR, \fB\-\-port\fR=\fI<port>\fR
aMule's port for External Connections, as set in Preferences->Remote Controls (default: \fI4712\fR)
.TP
\fB\-P\fR, \fB\-\-password\fR=\fI<passwd>\fR
External Connections password
.TP
\fB\-f\fR, \fB\-\-config\-file\fR=\fI<path>\fR
Use the given configuration file.
Default configuration file is \fI~/.aMule/remote.conf\fR
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Do not print any output to stdout. This seems to be a very much useless option with \fBamulecmd\fR.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Be verbose \- show also debug messages
.TP
\fB\-l\fR, \fB\-\-locale\fR=\fI<lang>\fR
Sets program locale (language).
See section \fBLANGUAGES\fR for the description of the \fI<lang>\fR parameter.
.TP
\fB\-w\fR, \fB\-\-write\-config\fR
Write command line options to config file and exit
.TP
\fB\-c\fR, \fB\-\-command\fR=\fI<command>\fR
Execute \fI<command>\fR as if it was entered at amulecmd's prompt and exit.
.TP
\fB\-\-create\-config\-from\fR=\fI<path>\fR
Create config file based upon \fI<path>\fR, which must point to a valid aMule config file, and then exit
.TP
\fB\-\-help\fR
Prints a short usage description.
.TP
\fB\-\-version\fR
Displays the current version number.
.SH COMMANDS
All commands are case insensitive.
.SS \fBAdd\fR <ed2k-link>
Adds an ed2k-link to the core.

The ed2k link to be added can be:
.br
*) a file link (ed2k://|file|...), it will be added to the download queue;
.br
*) a server link (ed2k://|server|...), it will be added to the server list;
.br
*) or a serverlist link, in which case all servers in the list will be added to the server list.

This command must have an argument.
.SS \fBCancel\fR <hash>
Cancels the download specified by hash. To get the hash use \fIshow\fR.
.SS \fBConnect\fR (kad|ed2k<ip|name>)
Connect to the network.

This will connect to all networks that are enabled in Preferences.

When giving ed2k as parameter, it connects only to ed2k-network to servers in your
serverlist. You may also optionally specify a server address in IP:Port form, to
connect to that server only. The IP must be a dotted decimal IPv4 address, or a
resolvable DNS name.

When giving kad, it connects to Kad only.
.SS \fBDisconnect\fR (ed2k|kad)

Disconnect from all networks you are connected to, or just disconnect from the
specified network.
.SS \fBDownload\fR num
Start downloading a file.

The number of a file from the last search has to be given.
Example: 'download 12' will start to download the file with the number 12 of the
previous search.

This command must have an argument.
.SS \fBExit\fR
Disconnect from amule/amuled and quit amulecmd.
.SS \fBGet\fR value
Get and display a preference value.

This command is incomplete, available values are listed below.

Available values to get:
.br
BwLimits	Get bandwidth limits.
.br
IPFilter	Get IPFilter preferences.
.SS \fBHelp\fR <command>
Get a short help.
If called without parameter, it shows a list of available commands.
If called with <command>, it shows a short description of the given command.
.SS \fBPause\fR <hash>
Pauses the download specified by hash. To get the hash use \fIshow\fR.
.SS \fBProgress\fR
Shows the progress of an on\-going search.

This command can't have an argument.
.SS \fBQuit\fR
Exits the App.

This command can't have an argument.
.SS \fBReload\fR
Reloads a given object.

This command is incomplete, available values are listed below.

Available values to get:
.br
BwLimits	Reload bandwidth limits.
.br
IPFilter	Reload IPFilter preferences.
.SS \fBReset\fR
Reset the log.

This command can't have an argument.
.SS Results\fR
Shows you the results of the last search.

This command can't have an argument.
.SS \fBResume\fR <hash>
Resumes the download specified by hash. To get the hash use \fIshow\fR.
.SS \fBSearch\fR global|kad|local file
Makes a search for the given file. A searchtype and a file to search is mandatory
to do this.
\fIExample\fR 'search kad amule' performs a kad search for amule.

Available searchtypes:
.br
global	performs a global search
.br
kad	performs a search on kad network
.br
local	performs a local search
.SS \fBSet\fR <value>
Sets a given preferences value.

This command is incomplete, available values are listed below.

Available values to get:
.br
BwLimits	Set bandwidth limits.
.br
IPFilter	Set IPFilter preferences.
.SS \fBShow\fR DL|Log|Servers|UL
Shows upload/download queue, servers list or shared files list.

This command must have an argument.

This command is incomplete, you must use one of the extensions below.

Available extensions:
.br
DL		Show download queue.
.br
Log		Show log.
.br
Servers	Show servers list.
.br
UL		Show upload queue.
.SS \fBShutdown\fR
Shutdown the remote running core (amule/amuled).
This will also shut down the text client, since it is unusable without a running
core.

This command can't have an argument.
.SS \fBStatistics\fR <num>
Show statistics tree.

The optional number in the range of 0-255 can be passed as argument to this
command, which tells how many entries of the client version subtree should be
shown. Passing 0, or omitting it means 'unlimited'.

\fIExample:\fR 'statistics 5' will show only the top 5 versions for each client
type.
.SS \fBStatus\fR
Show connection status, current up/download speeds, etc.
.PP
.SH NOTES
.SS Paths
For all options which take a \fI<path>\fR value, if the \fIpath\fR contains no
directory part (i.e. just a plain filename), then it is considered to be under
the aMule configuration directory, \fI~/.aMule\fR.
.SS LANGUAGES
The \fI<lang>\fR parameter for the \fB\-l\fR option has the following form: \fIlang\fR[\fB_\fILANG\fR][\fB.\fIencoding\fR][\fB@\fImodifier\fR]
where \fIlang\fR is the primary language, \fILANG\fR is a sublanguage/territory,
\fIencoding\fR is the character set to use and \fImodifier\fR
"allows the user to select a specific instance of localization data within a
single category".
.PP
For example, the following strings are valid:
.br
de
.br
de_DE
.br
de_DE.iso88591
.br
de_DE@euro
.br
de_DE.iso88591@euro
.PP
Though all the above strings are accepted as valid language definitions,
\fIencoding\fR and \fImodifier\fR are yet unused.
.PP
In addition to the format above, you can also specify full language names in
English - so \fB\-l german\fR is also valid and is equal to \fB-l de_DE\fR.
.PP
When no locale is defined, either on command-line or in config file, system
default language will be used.
.SH FILES
~/.aMule/remote.conf
.SH EXAMPLE
Typically amulecmd will be first run as:
.PP
\fBamulecmd\fR \fB\-h\fR \fIhostname\fR \fB\-p\fR \fIECport\fR \fB\-P\fR \fIECpassword\fR \fB\-w\fR
.PP
or
.PP
\fBamulecmd\fR \fB\-\-create-config-from\fR=\fI/home/username/.aMule/amule.conf\fR
.PP
These will save settings to \fI$HOME/.aMule/remote.conf\fR, and later you only need to type:
.PP
.B amulecmd
.PP
Of course, you don't have to follow this example.
.SH REPORTING BUGS
Please report bugs either on our forum (\fIhttp://forum.amule.org/\fR), or in our bugtracker (\fIhttp://bugs.amule.org/\fR).
Please do not report bugs in e-mail, neither to our mailing list nor directly to any team member.
.SH COPYRIGHT
aMule and all of its related utilities are distributed under the GNU General Public License.
.SH SEE ALSO
\fBamule\fR(1), \fBamuleweb\fR(1)
